home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / dhsein.z / dhsein
Text File  |  1996-03-14  |  8KB  |  199 lines
  1.  
  2.  
  3.  
  4. DDDDHHHHSSSSEEEEIIIINNNN((((3333FFFF))))                                                          DDDDHHHHSSSSEEEEIIIINNNN((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      DHSEIN - use inverse iteration to find specified right and/or left
  10.      eigenvectors of a real upper Hessenberg matrix H
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE DHSEIN( SIDE, EIGSRC, INITV, SELECT, N, H, LDH, WR, WI, VL,
  14.                         LDVL, VR, LDVR, MM, M, WORK, IFAILL, IFAILR, INFO )
  15.  
  16.          CHARACTER      EIGSRC, INITV, SIDE
  17.  
  18.          INTEGER        INFO, LDH, LDVL, LDVR, M, MM, N
  19.  
  20.          LOGICAL        SELECT( * )
  21.  
  22.          INTEGER        IFAILL( * ), IFAILR( * )
  23.  
  24.          DOUBLE         PRECISION H( LDH, * ), VL( LDVL, * ), VR( LDVR, * ),
  25.                         WI( * ), WORK( * ), WR( * )
  26.  
  27. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  28.      DHSEIN uses inverse iteration to find specified right and/or left
  29.      eigenvectors of a real upper Hessenberg matrix H.
  30.  
  31.      The right eigenvector x and the left eigenvector y of the matrix H
  32.      corresponding to an eigenvalue w are defined by:
  33.  
  34.                   H * x = w * x,     y**h * H = w * y**h
  35.  
  36.      where y**h denotes the conjugate transpose of the vector y.
  37.  
  38.  
  39. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  40.      SIDE    (input) CHARACTER*1
  41.              = 'R': compute right eigenvectors only;
  42.              = 'L': compute left eigenvectors only;
  43.              = 'B': compute both right and left eigenvectors.
  44.  
  45.      EIGSRC  (input) CHARACTER*1
  46.              Specifies the source of eigenvalues supplied in (WR,WI):
  47.              = 'Q': the eigenvalues were found using DHSEQR; thus, if H has
  48.              zero subdiagonal elements, and so is block-triangular, then the
  49.              j-th eigenvalue can be assumed to be an eigenvalue of the block
  50.              containing the j-th row/column.  This property allows DHSEIN to
  51.              perform inverse iteration on just one diagonal block.  = 'N': no
  52.              assumptions are made on the correspondence between eigenvalues
  53.              and diagonal blocks.  In this case, DHSEIN must always perform
  54.              inverse iteration using the whole matrix H.
  55.  
  56.      INITV   (input) CHARACTER*1
  57.              = 'N': no initial vectors are supplied;
  58.              = 'U': user-supplied initial vectors are stored in the arrays VL
  59.              and/or VR.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. DDDDHHHHSSSSEEEEIIIINNNN((((3333FFFF))))                                                          DDDDHHHHSSSSEEEEIIIINNNN((((3333FFFF))))
  71.  
  72.  
  73.  
  74.      SELECT  (input/output) LOGICAL array, dimension (N)
  75.              Specifies the eigenvectors to be computed. To select the real
  76.              eigenvector corresponding to a real eigenvalue WR(j), SELECT(j)
  77.              must be set to .TRUE.. To select the complex eigenvector
  78.              corresponding to a complex eigenvalue (WR(j),WI(j)), with complex
  79.              conjugate (WR(j+1),WI(j+1)), either SELECT(j) or SELECT(j+1) or
  80.              both must be set to
  81.  
  82.      N       (input) INTEGER
  83.              The order of the matrix H.  N >= 0.
  84.  
  85.      H       (input) DOUBLE PRECISION array, dimension (LDH,N)
  86.              The upper Hessenberg matrix H.
  87.  
  88.      LDH     (input) INTEGER
  89.              The leading dimension of the array H.  LDH >= max(1,N).
  90.  
  91.      WR      (input/output) DOUBLE PRECISION array, dimension (N)
  92.              WI      (input) DOUBLE PRECISION array, dimension (N) On entry,
  93.              the real and imaginary parts of the eigenvalues of H; a complex
  94.              conjugate pair of eigenvalues must be stored in consecutive
  95.              elements of WR and WI.  On exit, WR may have been altered since
  96.              close eigenvalues are perturbed slightly in searching for
  97.              independent eigenvectors.
  98.  
  99.      VL      (input/output) DOUBLE PRECISION array, dimension (LDVL,MM)
  100.              On entry, if INITV = 'U' and SIDE = 'L' or 'B', VL must contain
  101.              starting vectors for the inverse iteration for the left
  102.              eigenvectors; the starting vector for each eigenvector must be in
  103.              the same column(s) in which the eigenvector will be stored.  On
  104.              exit, if SIDE = 'L' or 'B', the left eigenvectors specified by
  105.              SELECT will be stored consecutively in the columns of VL, in the
  106.              same order as their eigenvalues. A complex eigenvector
  107.              corresponding to a complex eigenvalue is stored in two
  108.              consecutive columns, the first holding the real part and the
  109.              second the imaginary part.  If SIDE = 'R', VL is not referenced.
  110.  
  111.      LDVL    (input) INTEGER
  112.              The leading dimension of the array VL.  LDVL >= max(1,N) if SIDE
  113.              = 'L' or 'B'; LDVL >= 1 otherwise.
  114.  
  115.      VR      (input/output) DOUBLE PRECISION array, dimension (LDVR,MM)
  116.              On entry, if INITV = 'U' and SIDE = 'R' or 'B', VR must contain
  117.              starting vectors for the inverse iteration for the right
  118.              eigenvectors; the starting vector for each eigenvector must be in
  119.              the same column(s) in which the eigenvector will be stored.  On
  120.              exit, if SIDE = 'R' or 'B', the right eigenvectors specified by
  121.              SELECT will be stored consecutively in the columns of VR, in the
  122.              same order as their eigenvalues. A complex eigenvector
  123.              corresponding to a complex eigenvalue is stored in two
  124.              consecutive columns, the first holding the real part and the
  125.              second the imaginary part.  If SIDE = 'L', VR is not referenced.
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. DDDDHHHHSSSSEEEEIIIINNNN((((3333FFFF))))                                                          DDDDHHHHSSSSEEEEIIIINNNN((((3333FFFF))))
  137.  
  138.  
  139.  
  140.      LDVR    (input) INTEGER
  141.              The leading dimension of the array VR.  LDVR >= max(1,N) if SIDE
  142.              = 'R' or 'B'; LDVR >= 1 otherwise.
  143.  
  144.      MM      (input) INTEGER
  145.              The number of columns in the arrays VL and/or VR. MM >= M.
  146.  
  147.      M       (output) INTEGER
  148.              The number of columns in the arrays VL and/or VR required to
  149.              store the eigenvectors; each selected real eigenvector occupies
  150.              one column and each selected complex eigenvector occupies two
  151.              columns.
  152.  
  153.      WORK    (workspace) DOUBLE PRECISION array, dimension ((N+2)*N)
  154.  
  155.      IFAILL  (output) INTEGER array, dimension (MM)
  156.              If SIDE = 'L' or 'B', IFAILL(i) = j > 0 if the left eigenvector
  157.              in the i-th column of VL (corresponding to the eigenvalue w(j))
  158.              failed to converge; IFAILL(i) = 0 if the eigenvector converged
  159.              satisfactorily. If the i-th and (i+1)th columns of VL hold a
  160.              complex eigenvector, then IFAILL(i) and IFAILL(i+1) are set to
  161.              the same value.  If SIDE = 'R', IFAILL is not referenced.
  162.  
  163.      IFAILR  (output) INTEGER array, dimension (MM)
  164.              If SIDE = 'R' or 'B', IFAILR(i) = j > 0 if the right eigenvector
  165.              in the i-th column of VR (corresponding to the eigenvalue w(j))
  166.              failed to converge; IFAILR(i) = 0 if the eigenvector converged
  167.              satisfactorily. If the i-th and (i+1)th columns of VR hold a
  168.              complex eigenvector, then IFAILR(i) and IFAILR(i+1) are set to
  169.              the same value.  If SIDE = 'L', IFAILR is not referenced.
  170.  
  171.      INFO    (output) INTEGER
  172.              = 0:  successful exit
  173.              < 0:  if INFO = -i, the i-th argument had an illegal value
  174.              > 0:  if INFO = i, i is the number of eigenvectors which failed
  175.              to converge; see IFAILL and IFAILR for further details.
  176.  
  177. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  178.      Each eigenvector is normalized so that the element of largest magnitude
  179.      has magnitude 1; here the magnitude of a complex number (x,y) is taken to
  180.      be |x|+|y|.
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.